src/storage.ts (3)

33-33: ⚠️ Potential issue

Update JSDoc return type to match implementation

The JSDoc comment specifies a return type of Promise<T | void>, but the actual implementation now returns Promise<T | string>. This mismatch could lead to confusion for developers.

- @returns {Promise<T | void>} Returns the data stored in local storage or undefined if no data is found
+ @returns {Promise<T | string>} Returns the data stored in local storage or a message string if operation was successful or an error occurred

---

49-49: 🛠️ Refactor suggestion

Consider returning structured error responses instead of plain strings

The function now returns string messages in several places, which makes error handling more difficult for consumers of this API. They would need to check if the return value is a string to determine if an error occurred.

Consider returning structured responses that clearly indicate success/failure:

export async function lscStorage<T extends Record<string, any>>(key: string, value?: T): Promise<{data: T | null, success: boolean, message: string}> {
  try {
    if (value !== undefined) {
      localStorage.setItem(key, JSON.stringify(value));
-     return `${key} stored in local storage!`;
+     return {data: null, success: true, message: `${key} stored in local storage!`};
    } else {
      const data = localStorage.getItem(key);
      if (data) {
        try {
-         return JSON.parse(data) as T;
+         return {data: JSON.parse(data) as T, success: true, message: ""};
        } catch (error) {
          console.error("Failed to parse the data from local storage", error);
-         return "Failed to parse the data from local storage";
+         return {data: null, success: false, message: "Failed to parse the data from local storage"};
        }
      }
-     return "No data found in local storage";
+     return {data: null, success: false, message: "No data found in local storage"};
    }
  } catch (error) {
    if (error instanceof DOMException && error.name === "QuotaExceededError") {
      console.log("Storage is full, please clear some space!");
    } else {
      console.error("Error accessing local storage", error);
    }
-   return "Error accessing local storage";
+   return {data: null, success: false, message: "Error accessing local storage"};
  }
}

Also applies to: 57-58, 60-60, 68-69

---

13-13: ⚠️ Potential issue

Update overload signatures to match the implementation

The function overload signatures on lines 13 and 26 no longer match the actual implementation. These should be updated to reflect the new return type.

- export async function lscStorage<T extends Record<string, any>>(key: string, value: T): Promise<void>;
+ export async function lscStorage<T extends Record<string, any>>(key: string, value: T): Promise<string>;

- export async function lscStorage<T extends Record<string, any>>(key: string): Promise<T | null>;
+ export async function lscStorage<T extends Record<string, any>>(key: string): Promise<T | string>;

Also applies to: 26-26

src/storage.ts (1)

45-45: Improvement needed for deprecation comment

The comment "this method need to be remove as soon as possible" has grammatical issues and lacks context. The file already uses proper @deprecated JSDoc tags, so it would be better to:

1. Add more context about why it needs to be removed
2. Indicate what should be used instead
3. Fix the grammar

- // this method need to be remove as soon as possible
+ // TODO: This method needs to be removed as soon as possible. 
+ // Replacement: Use the new storageAPI methods instead.

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro